home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 6 / CU Amiga Magazine's Super CD-ROM 06 (1996)(EMAP Images)(GB)(Track 1 of 4)[!][issue 1997-01].iso / cucd / prog / mui / muibuilder / mb / tools / readme < prev    next >
Text File  |  1994-09-28  |  3KB  |  97 lines
  1.  
  2.     Small documentation written by Eric Totel on 27.September.1994
  3.  
  4.         --------------------------------
  5.         - BumpRevv.rexx and MUIBuilder -
  6.         -       How to use them ?      -
  7.         --------------------------------
  8.  
  9.  
  10. I.  BumpRev.rexx : what is it ?
  11. -------------------------------
  12.  
  13. In this directory, you can find an ARexx script called 'BumpRev.rexx'.
  14.  
  15. This script is an enhanced version of Bumprev from Commodore. Its goal
  16. is to manage and to provide a way to update the strings version in
  17. your programs (C and assembly).
  18.  
  19. The use of this script is really simple :
  20.  
  21.  
  22. The template is :
  23. "Name/A,Version,Revision,File/K,Copyright/K,IncRev/K/S,Verbose/K/S,Asm/K/S"
  24.  
  25. An example of use could be :
  26. rx bumprev.rexx Name prog File revision.h Version 1 Revision 0 Copyright "© by Sylvain Rougier" IncRev Verbose
  27.  
  28. Here is the output of the previous command (in file revision.h) :
  29.  
  30. #define REVISION 0
  31. #define VERSIONREVISION "1.0"
  32. #define DATE 27.09.94
  33. #define VERS "prog 1.0"
  34. #define VSTRING "prog 1.0 (27.09.94)\r\n"
  35. #define VERSTAG "$VER:prog 1.0 (27.09.94)"
  36.  
  37.  
  38. II.  Author.
  39. ------------
  40.  
  41. BumpRev.rexx was written by Sylvain Rougier and Pierre Carrette (who improved
  42. it to fit MUIBuilder's needs !!!!)
  43.  
  44. III. Requirements.
  45. ------------------
  46.  
  47. This hack will probably work only with C language (thanks to the
  48. macros !!!!!!), so you have to use C.
  49.  
  50. To run the script, you have to use the RexxDosSupport.library
  51. which is provided in this directory in its original archive.
  52.  
  53. This library is freely distributable, but copyrighted by
  54.  
  55.     ***  Hartmut Goebel ***
  56.  
  57. For more informations, please read the documentation included
  58. in the archive RexxDosSupport.lha.
  59.  
  60.  
  61. IV. Use with MUIBuilder.
  62. ------------------------
  63.  
  64. This script is useful for C users !!!! It provides the ability to handle
  65. the well-known VERSION strings macros directly inside MUIBuilder.
  66.  
  67. BumpRev.rexx will update your version string according to the arguments
  68. you provided.
  69.  
  70. You just have to enter some special strings into the application
  71. object attributes :
  72.  
  73. - Base        : the name of your application        (as usual)
  74. - Author    : your name                (as usual)
  75. - Title        : "VERS"
  76. - Version    : "VERSTAG"
  77. - Copyright    : "VERS" © your name
  78. - Description    : a description of your application    (as usual)
  79.  
  80. Before any code generation, edit one of the files 'C-Header' or 'H-Header'
  81. located in the 'Modules' directory. Add in the file of your choice the line
  82. '#include "revision.h"' where "revision.h" is the output file of BumpRev.rexx.
  83.  
  84. With BumpRev.rexx you can generate the same file "version.h" for every
  85. project : so this change in 'H-Header' or 'C-Header' is valid for all
  86. of these projects.
  87.  
  88. V. Greetings.
  89. -------------
  90.  
  91. I want to thank Pierre Carrette who provided me
  92. with this script and made some improvements so that it works with MUIBuider !
  93.  
  94. you can contact Pierre Carrette at :
  95.  
  96.     Pierre Carrette : bvme@chasseneuil.em.slb.com
  97.